home *** CD-ROM | disk | FTP | other *** search
/ Chip 2007 January, February, March & April / Chip-Cover-CD-2007-02.iso / Pakiet bezpieczenstwa / mini Pentoo LiveCD 2006.1 / mpentoo-2006.1.iso / livecd.squashfs / usr / lib / mozilla-firefox / include / dom / nsIDOMWindowUtils.h < prev    next >
C/C++ Source or Header  |  2006-05-08  |  5KB  |  137 lines
  1. /*
  2.  * DO NOT EDIT.  THIS FILE IS GENERATED FROM nsIDOMWindowUtils.idl
  3.  */
  4.  
  5. #ifndef __gen_nsIDOMWindowUtils_h__
  6. #define __gen_nsIDOMWindowUtils_h__
  7.  
  8.  
  9. #ifndef __gen_nsISupports_h__
  10. #include "nsISupports.h"
  11. #endif
  12.  
  13. /* For IDL files that don't want to include root IDL files. */
  14. #ifndef NS_NO_VTABLE
  15. #define NS_NO_VTABLE
  16. #endif
  17.  
  18. /* starting interface:    nsIDOMWindowUtils */
  19. #define NS_IDOMWINDOWUTILS_IID_STR "8a157a4f-a81e-489f-baf2-bc8970d60472"
  20.  
  21. #define NS_IDOMWINDOWUTILS_IID \
  22.   {0x8a157a4f, 0xa81e, 0x489f, \
  23.     { 0xba, 0xf2, 0xbc, 0x89, 0x70, 0xd6, 0x04, 0x72 }}
  24.  
  25. /**
  26.  * nsIDOMWindowUtils is intended for giving privileged script access to
  27.  * additional properties and methods of nsIDOMWindow unavailable to
  28.  * content script. Access this interface by calling getInterface on a DOMWindow.
  29.  */
  30. class NS_NO_VTABLE nsIDOMWindowUtils : public nsISupports {
  31.  public: 
  32.  
  33.   NS_DEFINE_STATIC_IID_ACCESSOR(NS_IDOMWINDOWUTILS_IID)
  34.  
  35.   /**
  36.    * Image animation mode of the window. When this attribute's value
  37.    * is changed, the implementation should set all images in the window
  38.    * to the given value. That is, when set to kDontAnimMode, all images
  39.    * will stop animating. The attribute's value must be one of the
  40.    * animationMode values from imgIContainer.
  41.    * @note Images may individually override the window's setting after
  42.    *       the window's mode is set. Therefore images given different modes
  43.    *       since the last setting of the window's mode may behave
  44.    *       out of line with the window's overall mode.
  45.    * @note The attribute's value is the window's overall mode. It may
  46.    *       for example continue to report kDontAnimMode after all images
  47.    *       have subsequently been individually animated.
  48.    * @note Only images immediately in this window are affected;
  49.    *       this is not recursive to subwindows.
  50.    * @see imgIContainer
  51.    */
  52.   /* attribute unsigned short imageAnimationMode; */
  53.   NS_IMETHOD GetImageAnimationMode(PRUint16 *aImageAnimationMode) = 0;
  54.   NS_IMETHOD SetImageAnimationMode(PRUint16 aImageAnimationMode) = 0;
  55.  
  56.   /**
  57.    * Function to get metadata associated with the window's current document
  58.    * @param aName the name of the metadata.  This should be all lowercase.
  59.    * @return the value of the metadata, or the empty string if it's not set
  60.    */
  61.   /* AString getDocumentMetadata (in AString aName); */
  62.   NS_IMETHOD GetDocumentMetadata(const nsAString & aName, nsAString & _retval) = 0;
  63.  
  64. };
  65.  
  66. /* Use this macro when declaring classes that implement this interface. */
  67. #define NS_DECL_NSIDOMWINDOWUTILS \
  68.   NS_IMETHOD GetImageAnimationMode(PRUint16 *aImageAnimationMode); \
  69.   NS_IMETHOD SetImageAnimationMode(PRUint16 aImageAnimationMode); \
  70.   NS_IMETHOD GetDocumentMetadata(const nsAString & aName, nsAString & _retval); 
  71.  
  72. /* Use this macro to declare functions that forward the behavior of this interface to another object. */
  73. #define NS_FORWARD_NSIDOMWINDOWUTILS(_to) \
  74.   NS_IMETHOD GetImageAnimationMode(PRUint16 *aImageAnimationMode) { return _to GetImageAnimationMode(aImageAnimationMode); } \
  75.   NS_IMETHOD SetImageAnimationMode(PRUint16 aImageAnimationMode) { return _to SetImageAnimationMode(aImageAnimationMode); } \
  76.   NS_IMETHOD GetDocumentMetadata(const nsAString & aName, nsAString & _retval) { return _to GetDocumentMetadata(aName, _retval); } 
  77.  
  78. /* Use this macro to declare functions that forward the behavior of this interface to another object in a safe way. */
  79. #define NS_FORWARD_SAFE_NSIDOMWINDOWUTILS(_to) \
  80.   NS_IMETHOD GetImageAnimationMode(PRUint16 *aImageAnimationMode) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetImageAnimationMode(aImageAnimationMode); } \
  81.   NS_IMETHOD SetImageAnimationMode(PRUint16 aImageAnimationMode) { return !_to ? NS_ERROR_NULL_POINTER : _to->SetImageAnimationMode(aImageAnimationMode); } \
  82.   NS_IMETHOD GetDocumentMetadata(const nsAString & aName, nsAString & _retval) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetDocumentMetadata(aName, _retval); } 
  83.  
  84. #if 0
  85. /* Use the code below as a template for the implementation class for this interface. */
  86.  
  87. /* Header file */
  88. class nsDOMWindowUtils : public nsIDOMWindowUtils
  89. {
  90. public:
  91.   NS_DECL_ISUPPORTS
  92.   NS_DECL_NSIDOMWINDOWUTILS
  93.  
  94.   nsDOMWindowUtils();
  95.  
  96. private:
  97.   ~nsDOMWindowUtils();
  98.  
  99. protected:
  100.   /* additional members */
  101. };
  102.  
  103. /* Implementation file */
  104. NS_IMPL_ISUPPORTS1(nsDOMWindowUtils, nsIDOMWindowUtils)
  105.  
  106. nsDOMWindowUtils::nsDOMWindowUtils()
  107. {
  108.   /* member initializers and constructor code */
  109. }
  110.  
  111. nsDOMWindowUtils::~nsDOMWindowUtils()
  112. {
  113.   /* destructor code */
  114. }
  115.  
  116. /* attribute unsigned short imageAnimationMode; */
  117. NS_IMETHODIMP nsDOMWindowUtils::GetImageAnimationMode(PRUint16 *aImageAnimationMode)
  118. {
  119.     return NS_ERROR_NOT_IMPLEMENTED;
  120. }
  121. NS_IMETHODIMP nsDOMWindowUtils::SetImageAnimationMode(PRUint16 aImageAnimationMode)
  122. {
  123.     return NS_ERROR_NOT_IMPLEMENTED;
  124. }
  125.  
  126. /* AString getDocumentMetadata (in AString aName); */
  127. NS_IMETHODIMP nsDOMWindowUtils::GetDocumentMetadata(const nsAString & aName, nsAString & _retval)
  128. {
  129.     return NS_ERROR_NOT_IMPLEMENTED;
  130. }
  131.  
  132. /* End of implementation class template. */
  133. #endif
  134.  
  135.  
  136. #endif /* __gen_nsIDOMWindowUtils_h__ */
  137.